Skip to content

chore(influxdb3-distrib): Recommend best practices for adjusting client timeouts when querying InfluxDB 3 distributed. #6294

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Aug 13, 2025

Conversation

jstirnaman
Copy link
Contributor

  • Closes influxdata/dar#526
  • Adds Python client examples
  • Adds influxctl examples

Co-authored-by: Reid Kaufmann

Closes #

Describe your proposed changes here.

…nt timeouts when querying InfluxDB 3 distributed.

- Closes influxdata/DAR#526
- Adds Python client examples
- Adds influxctl examples

Co-authored-by: Reid Kaufmann
Copy link
Contributor

@reidkaufmann reidkaufmann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like there was some AI-assist that needs some attention. I like how it organizes things into bite size sections with bullet points, which makes it easy to consume fast, but I think it introduces some content we don't want (suggests unhelpful solutions that are and implies a non-existent feature).

…practices

Address reidkaufmann's review comments on query timeout documentation:

Technical accuracy fixes:
- Replace "node/nodes" terminology with "querier/queriers" throughout
- Remove AI hallucination: "query result caching" (doesn't exist in IOx)
- Replace with proper cache recommendations for Enterprise/Core users
- Remove vague "background maintenance" references
- Add specific compaction performance variation cause
- Fix "round-robin or load-balanced" → "round-robin query routing"

Content improvements:
- Enhance checkout line analogy with explanation of noisy neighbors
- Add experimental query guidance for reducing impact on other users
- Replace unactionable solutions with customer-controllable actions
- Restore missing flexibility recommendations and link to the code sample

Technical updates:
- Update code blocks to use new placeholder syntax
- Add related links between cache documentation and timeout strategies
- Fix numbering consistency in Solutions sections
Copy link
Contributor Author

@jstirnaman jstirnaman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did we lose some of the recommendations I had suggested. (note: I don't mind if you cut them, but I'm now suspicious of the AI)

When introducing a new query to your application or when issuing ad-hoc queries to a database with many users, even if unintended, your query might be the "noisy neighbor" or shopping cart overloaded with groceries. By setting a tighter timeout on experimental queries you can reduce the impact on other users.

Write your client app so that it's easy to adjust the query timeout on the fly

Yes, I added a code sample, but accidentally left out your text. I added it back with a link to the sample.

Copy link
Contributor

@reidkaufmann reidkaufmann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for quickly addressing my laundry list. 😅

I had one minor additional comment.

@jstirnaman jstirnaman merged commit 7de4b11 into master Aug 13, 2025
5 checks passed
@jstirnaman jstirnaman deleted the jts-dar-526-clustered-timeouts branch August 13, 2025 14:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants